docs: Update the library name to include the Arduino prefix#22
docs: Update the library name to include the Arduino prefix#22sebromero merged 13 commits intoarduino-libraries:mainfrom
Conversation
Following the [policy](https://forum.arduino.cc/t/new-official-policy-for-the-use-of-arduino-in-library-names/580564) the Arduino official libraries must start with Arduino. Changed the name into `Arduino Modulino` to respect the policy
Arduino prefix
per1234
left a comment
There was a problem hiding this comment.
To accompany the name change I suggest the addition of a header file named Arduino_Modulino.h, and changing the examples to use that file in the #include directive instead of Modulino.h.
The reason is that the match between the library name and the header file name is a factor in library discovery:
https://arduino.github.io/arduino-cli/dev/sketch-build-process/#library-name-priority
So it is best practices that, in a case like this where a library has a primary header file, that filename match the library name. This will reduce the chance of ambiguity in the library discovery.
This can be done in a non-breaking manner by leaving the existing Modulino.h file in place. One of the two header files should simply contain an #include directive for the other file. For example:
Arduino_Modulino.h:
#include "Modulino.h"There was a problem hiding this comment.
|
@dido18 I've recently added documentation to the library. Please resolve any conflicts before merging and make sure to integrate the documentation. Thanks! :) |
… Arduino_Modulino.h
Motivation
Following the policy the Arduino official libraries must start with "Arduino"
Changes
nameintoArduino_ModulinoArduino_Modulino.hheader (that includes the oldModulino.h)